home *** CD-ROM | disk | FTP | other *** search
/ Teach Yourself VRML 2 in 21 Days / Teach Yourself VRML 2 in 21 Days.iso / mac / ISO9660 / 3rdparty / POLYTRAN / dos / PT_DOS.ZIP / DOC_1 / EXP_WAVE.1 < prev    next >
Encoding:
Text File  |  1996-06-13  |  4.4 KB  |  103 lines
  1. .so psroff.inc        # Include the macros needed for output to Postscript
  2. .TH Export-Wavefront
  3. .SH NAME
  4. exp_wave \- Wavefront .OBJ geometry export filter
  5. .SH SYNOPSIS
  6. .PP
  7. This man page describes the options specific to the Wavefront OBJ geometry
  8. export converter.
  9. .PP
  10. .SH EXAMPLE CONVERSION SYNTAX
  11. .PP
  12. To convert a 3D Studio file to Wavefront using the default parameters listed 
  13. in the setup.ini file:
  14. .IP
  15. pt -i 3ds -o wave filename.3ds
  16. .PP
  17. To convert a Lightwave file to Wavefront and override some of the default 
  18. options in setup.ini:
  19. .IP
  20. pt -i lw -o wave -out-output-material-file = no filename.lw
  21. .PP
  22. .SH OVERVIEW
  23. .PP
  24. The Wavefront OBJ geometry export converter writes out the scene database
  25. as a series of indexed polygons (faces and their associated indices)
  26. along with optional normal and texture data (if its exists within the
  27. database). A Wavefront material definition file (.mtl) can also be
  28. exported.
  29. .PP
  30. The exported .OBJ file will be compliant with the Wavefront .OBJ file
  31. format version 2.11 which defines polygonal geometry. Higher order
  32. primitives, such as NURB and bicubic patches will be converted into
  33. convex polygons before begin output.
  34. .PP
  35. Any concave polygons or polygons with holes will be triangulated before
  36. being output to the .OBJ file.
  37. .PP
  38. Polygons that belong to the same object within the converter's internal
  39. database will output as a single unique group within the .OBJ file with
  40. the group's name set equal to the internal object name; the
  41. group name is specified with the "g" command in the file.
  42. .PP
  43. No hierarchy information is output since the .OBJ file format has no methods
  44. to describing hierarchy; each sub-object of a hierarchy will nonetheless
  45. be exported as a unique group whose name's match the original object names
  46. in the internal database hierarchy.
  47. .PP
  48. .SH COMMAND LINE OPTIONS
  49. .PP
  50. The following options are specific to this export converter:
  51. .TP
  52. -o wave
  53. This is the mandatory command line option which specifies that the data
  54. is to be exported using the Wavefront OBJ format converter.
  55. .TP
  56. -out-wave-output-material-file = [ yes | no ]
  57. If this option is set to 'yes' then a Wavefront compatible material file
  58. will be output along with the main .obj geometry file.
  59. This file will have the same root filename as the input filename but with 
  60. a .mtl file extension (ie.: input = filename.3ds, output = filename.obj
  61. and filename.mtl).
  62. The material file will list all of the material definitions referenced
  63. by the geometry as well as specify some of the material properties such
  64. as Ns, Ka, Kd, Ks and the shading model (see below for their explanations).
  65. Note that the Wavefront material file does not accommodate texture filename 
  66. information. If this option is set to 'no' then no material file will be output.
  67. .TP
  68. -out-line-ending = [ cr | lf | crlf ]
  69. This common option selects which line terminator is to be used for the ASCII output 
  70. file. Files destined for DOS/PC machines should use 'crlf', files for UNIX 
  71. machines should use 'lf' and files for Macintosh machines should use 'cr'.
  72. The default is specific to which machine this converter is presently running
  73. on: 'crlf' for DOS/PC, 'lf' for UNIX and 'cr' for Macintosh. This option
  74. normally does not have to be specified unless you will be using the exported
  75. ASCII file on a different type of computer.
  76. .PP
  77. .SH MATERIAL FILE PARAMETERS
  78. .PP
  79. If the '-out-output-material-file' option is enabled then a material
  80. definition file (.mtl) will be output along with the geometry file. This
  81. file lists attributes of various materials. The mapping from the converter's
  82. internal parameters to the .mtl parameters are described as follows:
  83. .IP
  84. Ns = Phong specular component. Ranges from 0 to 200.
  85. .IP
  86. Kd = Diffuse color weighted by the diffuse coefficient.
  87. .IP
  88. Ka = Ambient color weighted by the ambient coefficient.
  89. .IP
  90. Ks = Specular color weighted by the specular coefficient.
  91. .IP
  92. d = Dissolve factor (pseudo-transparency). This is set to the internal face 
  93. transparency value.
  94. .IP
  95. illum 2 = Diffuse and specular shading model.
  96. .PP
  97. .SH LIMITATIONS
  98. .PP
  99. Since the converter's internal database does not allow materials to be
  100. assigned to specific vertices (it only allows color to be assigned to 
  101. vertices), it will not output any material assignments at the vertex level.
  102. However, it will output material assignments on a per polygon basis.
  103.